home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / super20.zip / SUPER.DOC < prev    next >
Text File  |  1990-09-03  |  6KB  |  159 lines
  1.      Superstat version 1.00 by Alain Tremblay 1:249/120
  2.  
  3.      This is a development package and is not directly supported
  4. at this point.  The finish product will produce all of the
  5. reports listed in the super.cfg file.
  6.  
  7.      Superstat version 1.00 is freeware, since it is not a finish
  8. product you may use it and distribute it at will, as long as this
  9. documentation is kept in the distribution package.  It may not be
  10. sold in any fashion, in this instance the act of selling includes
  11. a business who sells media containing public domain programs.
  12.  
  13. Users responsibility.
  14.  
  15.      If you use this program on your system, I would like to know
  16. that you are doing so, boosting my ego is a good way of getting
  17. me to complete the finish version in the least possible time.
  18. You are also responsible to let me know of any problems you might
  19. encounter, in such a case I will promptly respond and upgrade
  20. v1.00.   Superstat v1.00 is a beta test version it has been tested
  21. locally by QuickBBS sysops and any opinions or suggestions you might
  22. have are critical to the development of this program.  Please
  23. forward any information/suggestions/problems to;
  24.  
  25.      Alain Tremblay  Fidonet 1:249/120 or
  26.  
  27.      Alain Tremblay
  28.      General Delivery
  29.      Seeley's Bay, Ont.
  30.      Koh-2no
  31.  
  32.  
  33.      What is Superstat,
  34.  
  35.                Superstat creates statistics screens for QuickBBS,
  36. using your users.bbs.  It will handle a users base of up to 900
  37. users, anything above this might cause a problem and I would
  38. suggest not using it in these circumstances. This version can 
  39. create seven bulletin screens; top 10 callers, top 10 uploaders, top 10 
  40. message writers, top 10 doors and the worst 10 downloaders, The 
  41. QBBS system report and the binkley system report.
  42.  
  43.  
  44.      All colours are configurable.
  45.      All paths and filenames are configurable.
  46.  
  47. Black.lst
  48.  
  49.      You may create a file called black.lst, if you create this
  50. file it will not report on any name that is placed into this
  51. file.
  52.  
  53.      This file is created with a ascii editor of your choice or
  54. simply with the copy con command.  One name per line up to a
  55. maximum of 50 names, it is NOT case sensitive.
  56.  
  57.  
  58. Supercol.exe ; colour editor
  59.  
  60.      Superstat comes with a program called supercol.exe, supercol
  61. permits you to set the colours of the ansi bulletins created.
  62. Once the colour scheme is selected, it will offer you the
  63. opportunity to save the colours to the super.cfg file or to
  64. simply discard all your changes.  Supercol always starts with the
  65. currently selected colours.
  66.  
  67. Super.cfg ; configuration file.
  68.  
  69.      The configuration file contains all the necessary
  70. information on how to configure superstat.
  71.  
  72. Super.mnu ; Menu file for easy installation
  73.  
  74.     Created by Don Laverdure of Kingston Node 1:249/124 it 
  75. connects all the various menu under one roof to display to your user, 
  76. Don has graciously offered to make his menu part of the super package.
  77.  
  78.  
  79.  
  80. Installation.
  81.  
  82.      Simply unpack the super compressed file in the QuickBBS
  83. directory.  Modify the super.cfg file according to your
  84. requirements.  Run the supercol.exe program to set your default
  85. colours.  You may run super12.exe after every logon since it's
  86. quite fast or you may run it once a day during normal maintenance.
  87.  
  88. How to run it.
  89.  
  90.         Simply use super12 at the dos prompt or in your batch file
  91. no parameters are necessary, all pertinent information is located
  92. in the super.cfg configuration file.
  93.  
  94. The new doors module and logtime.exe
  95.  
  96.         QuickBBS doesn't provide sufficient information to make
  97. a good door logging utility.  Consequently to properly keep track
  98. of all doors they must be properly identified in the system.log.
  99. I'm introducing a program call logtime.exe.  Logtime will permit
  100. you to place entries in the log everytime a door is opened.  Another way
  101. to do it is to manually place an entry in the log through one of your
  102. menus.
  103.  
  104. Using logtime.exe for door report.
  105.  
  106.         Logtime.exe simply creates a QuickBBS style log entry.
  107. In your quickbbs.bat file or in your game.bat file enter the following
  108. line just prior to running the door.
  109.  
  110. logtime doors Tradewars 2.0
  111.  
  112. pgrname [doors] text to put in the system.log
  113.  
  114. The doors parameters is necessary for Superstat.  The text to put in
  115. the system.log should be kept as short as possible in order to be
  116. meaningful in the final bulletins.
  117.  
  118.         Now everytime this door is open, and entry will appear in the log
  119. with the name of the door, which will be picked up by superstat to create
  120. the bestdoors.asc/ans bulletin.
  121.  
  122.  
  123.      Guarantees...
  124.  
  125.           This program is guaranteed to take room on your hard
  126. disk.  It is not guaranteed in any other way.  I decline all
  127. responsibility or any consequence whatsoever derived from it's
  128. use. (even though it works well here..).
  129.  
  130.  
  131.  
  132.      This program is Shareware.  
  133.  
  134.     If you wish to use this program after 30 days there is 
  135. two ways to register your copy. 
  136.  
  137.     A) you send me a five buck donation at the address 
  138.     below specifying your name, address and node number (if so).
  139.  
  140.     B) You netmail me at 1:249/120 and let me know that you 
  141.     are using it, with your name, address and node number (if so).
  142.     This solution is the low cost registration option.
  143.  
  144.  
  145.      I do hope you enjoy using Superstat and that you will help
  146. in creating the finished product.  Beta testers are welcome and
  147. will be responded to in any eventuality.
  148.  
  149.                A. Tremblay Fidonet 1:249/120
  150.  
  151.      Alain Tremblay  Fidonet 1:249/120 or
  152.  
  153.      Alain Tremblay
  154.      General Delivery
  155.      Seeley's Bay, Ont.
  156.      Koh-2no
  157.  
  158.  
  159.